/*
 *
 *      Copyright (c) 2018-2025, lengleng All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice,
 *  this list of conditions and the following disclaimer.
 *  Redistributions in binary form must reproduce the above copyright
 *  notice, this list of conditions and the following disclaimer in the
 *  documentation and/or other materials provided with the distribution.
 *  Neither the name of the pig4cloud.com developer nor the names of its
 *  contributors may be used to endorse or promote products derived from
 *  this software without specific prior written permission.
 *  Author: lengleng (wangiegie@gmail.com)
 *
 */

package com.pig4cloud.pig.admin.api.entity;

import com.baomidou.mybatisplus.annotation.*;
import com.baomidou.mybatisplus.extension.activerecord.Model;
import io.swagger.v3.oas.annotations.media.Schema;
import jakarta.validation.constraints.NotBlank;
import lombok.Data;
import lombok.EqualsAndHashCode;

import java.time.LocalDateTime;

/**
 * OAuth2客户端信息实体类
 * <p>
 * 用于存储OAuth2客户端的详细配置信息，包括客户端凭证、授权模式、
 * 作用域、令牌有效期等。支持OAuth2的各种授权模式
 * </p>
 *
 * @author lengleng
 * @since 2018-05-15
 */
@Data
@Schema(description = "客户端信息")
@EqualsAndHashCode(callSuper = true)
public class SysOauthClientDetails extends Model<SysOauthClientDetails> {

	private static final long serialVersionUID = 1L;

	/**
	 * 主键
	 * <p>
	 * 采用雪花算法生成的唯一标识
	 * </p>
	 */
	@TableId(value = "id", type = IdType.ASSIGN_ID)
	@Schema(description = "id")
	private Long id;

	/**
	 * 客户端ID
	 * <p>
	 * OAuth2客户端唯一标识，用于客户端身份验证。
	 * 例如：app、web、admin等
	 * </p>
	 */
	@NotBlank(message = "client_id 不能为空")
	@Schema(description = "客户端id")
	private String clientId;

	/**
	 * 客户端密钥
	 * <p>
	 * 客户端的密钥，用于客户端身份验证。
	 * 应当加密存储，保证安全性
	 * </p>
	 */
	@NotBlank(message = "client_secret 不能为空")
	@Schema(description = "客户端密钥")
	private String clientSecret;

	/**
	 * 资源ID
	 * <p>
	 * 客户端可以访问的资源服务器ID列表，多个用逗号分隔。
	 * 用于限制客户端的资源访问范围
	 * </p>
	 */
	@Schema(description = "资源id列表")
	private String resourceIds;

	/**
	 * 作用域
	 * <p>
	 * OAuth2作用域，用于限定客户端的访问权限。
	 * 常用值：server（全部权限）、read（只读）、write（读写）等
	 * </p>
	 */
	@NotBlank(message = "scope 不能为空")
	@Schema(description = "作用域")
	private String scope;

	/**
	 * 授权方式
	 * <p>
	 * OAuth2支持的授权模式数组：
	 * - authorization_code：授权码模式
	 * - password：密码模式
	 * - client_credentials：客户端凭证模式
	 * - refresh_token：刷新令牌
	 * - sms：短信验证码模式（自定义）
	 * </p>
	 */
	@Schema(description = "授权方式")
	private String[] authorizedGrantTypes;

	/**
	 * 回调地址
	 * <p>
	 * 授权码模式下的重定向URI，在授权成功后将用户重定向到此地址。
	 * 多个地址用逗号分隔
	 * </p>
	 */
	@Schema(description = "回调地址")
	private String webServerRedirectUri;

	/**
	 * 权限
	 * <p>
	 * 客户端所拥有的Spring Security权限值，可选项。
	 * 用于进一步限制客户端的权限
	 * </p>
	 */
	@Schema(description = "权限列表")
	private String authorities;

	/**
	 * 请求令牌有效时间
	 * <p>
	 * Access Token的有效期，单位：秒。
	 * 默认值通常为12小时（43200秒）
	 * </p>
	 */
	@Schema(description = "请求令牌有效时间")
	private Integer accessTokenValidity;

	/**
	 * 刷新令牌有效时间
	 * <p>
	 * Refresh Token的有效期，单位：秒。
	 * 通常设置比Access Token更长，如30天（2592000秒）
	 * </p>
	 */
	@Schema(description = "刷新令牌有效时间")
	private Integer refreshTokenValidity;

	/**
	 * 扩展信息
	 * <p>
	 * JSON格式的扩展信息，用于存储额外的客户端配置
	 * </p>
	 */
	@Schema(description = "扩展信息")
	private String additionalInformation;

	/**
	 * 是否自动放行
	 * <p>
	 * 在授权码模式下，是否跳过用户确认授权页面。
	 * true：自动授权，false：需要用户手动确认
	 * </p>
	 */
	@Schema(description = "是否自动放行")
	private String autoapprove;

	/**
	 * 删除标记
	 * <p>
	 * 逻辑删除标记，0-正常，1-已删除
	 * </p>
	 */
	@TableLogic
	@TableField(fill = FieldFill.INSERT)
	@Schema(description = "删除标记,1:已删除,0:正常")
	private String delFlag;

	/**
	 * 创建人
	 */
	@TableField(fill = FieldFill.INSERT)
	@Schema(description = "创建人")
	private String createBy;

	/**
	 * 修改人
	 */
	@TableField(fill = FieldFill.UPDATE)
	@Schema(description = "修改人")
	private String updateBy;

	/**
	 * 创建时间
	 */
	@TableField(fill = FieldFill.INSERT)
	@Schema(description = "创建时间")
	private LocalDateTime createTime;

	/**
	 * 更新时间
	 */
	@TableField(fill = FieldFill.UPDATE)
	@Schema(description = "更新时间")
	private LocalDateTime updateTime;

}
